Add a new field for citation count #13531

SalvadorRomo · 2025-07-12T18:06:52Z

This PR add a new filed in the General Count to fetch the citationCount for a given Entry, with the ability to look it up.

Steps to test

1- Add a new paper
2- Go to the General Tab and
3 - Place your cursor in the new Citation Field
4- next to the field, there is button available to start the search
5- if the value is blank or the TTL for the actual Doi has expiered, the field must be filled with the expected value
6- if the there is an existing value or the TTL is not yet reached, it won't perform fetching and will keep the same value

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
[/] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

jabgui/src/main/java/org/jabref/gui/fieldeditors/identifier/CitationCountEditorViewModel.java

jablib/src/main/java/org/jabref/logic/importer/fetcher/citation/CitationFetcher.java

jablib/src/main/java/org/jabref/model/entry/field/FieldFactory.java

jabgui/src/main/java/org/jabref/gui/fieldeditors/FieldEditors.java

jabgui/src/main/java/org/jabref/gui/entryeditor/SciteTab.java

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditor.java

koppor

Close to finish 😅

We keep commenting to share our development knowledge with you with the hope that you learn something - otherwise, we would "just" finish the PR for our selves.

koppor · 2025-07-16T09:43:13Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditorViewModel.java

+                      .onRunning(() -> fetchCitationCountInProgress.setValue(true))
+                      .onFinished(() -> fetchCitationCountInProgress.setValue(false))
+                      .onFailure(e ->
+                          dialogService.showErrorDialogAndWait(Localization.lang("Error Occurred")))


This is not JabRef's style. The text does not contain any information what the user should do.

Rename string to Error occurred (also in JabRef_en.properties`)

dialogService.notify(...)

LOGGER.error("Error while fetching citation count", e)

With 3, there is a log entry, and users can see it in the log viewer accessible in the help menu.

koppor · 2025-07-16T09:43:41Z

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditorViewModel.java

+    }
+
+    public void getCitationCount() {
+        Optional<String> fieldAux = entry.getField(field);


aux is very strange. Maybe name it fieldContent

koppor · 2025-07-16T09:44:20Z

jabgui/src/main/resources/org/jabref/gui/fieldeditors/CitationCountEditor.fxml

+        <graphic>
+            <StackPane>
+                <JabRefIconView glyph="LOOKUP_IDENTIFIER"
+                                visible="${controller.viewModel.fetchCitationCountInProgress == false}"/>


Use !... instead of == false

koppor · 2025-07-16T09:45:22Z

jablib/src/main/java/org/jabref/logic/importer/fetcher/citation/CitationFetcher.java

+     * Get the paper details that includes citation count field for a given {@link BibEntry}.
+     *
+     * @param entry entry to search citation count field
+     * @return returns a {@link PaperDetails}, that includes citation count field (may be empty)


Ajdust JavaDoc to actual return value (Integer is not PaperDetails)

koppor · 2025-07-16T09:47:21Z

jablib/src/main/java/org/jabref/model/entry/field/StandardField.java

@@ -138,6 +138,7 @@ public enum StandardField implements Field {
    OWNER("owner"),
    TIMESTAMP("timestamp", FieldProperty.DATE),
    CREATIONDATE("creationdate", FieldProperty.DATE),
+    CITATIONCOUNT("Citation count"),


Please show the excerpt here.

I think, you ened to adapt jablib/src/test/resources/org/jabref/logic/exporter/OldOpenOfficeCalcExportFormatContentSingleEntry.xml accordingly. Which is OK - you add a thing there (and we have the discussion on that there. Maybe, this is really required)

(And please let us resolve the conversations so that we save one click while reviewing) - otherwise, I need to open all resolved conversations)

trag-bot · 2025-07-17T15:19:39Z

jablib/src/main/java/org/jabref/model/entry/field/StandardField.java

@@ -136,6 +136,7 @@ public enum StandardField implements Field {
    // JabRef-specific fields
    GROUPS("groups"),
    OWNER("owner"),
+    CITATIONCOUNT("Citation count"),


Field name should be in lowercase with underscores for consistency with other field names. The display name should be sentence case as per UI text guidelines.

Yes - how can this happen?

koppor

The space in the field name is strange.

An additional test (writing BibTeX and trying to read it) would have discoved it. However, too much effort for the gain. I fixed it.

I also parsed the error field and display it to the user at deee352 (#13531)

"Funny" DOI is 10.1145/1028174.971312, where no citation count is available, but the tab "Citation information" shows the count.

We will create a follow up issue (internal link https://github.com/JabRef/jabref-issue-melting-pot/issues/995).

I will let this through to move forward.

koppor · 2025-07-21T07:43:47Z

jablib/src/main/java/org/jabref/model/entry/field/StandardField.java

@@ -136,6 +136,7 @@ public enum StandardField implements Field {
    // JabRef-specific fields
    GROUPS("groups"),
    OWNER("owner"),
+    CITATIONCOUNT("Citation count"),


Yes - how can this happen?

trag-bot · 2025-07-21T12:34:39Z

@trag-bot didn't find any issues in the code! ✅✨

SalvadorRomo · 2025-07-21T16:28:55Z

thks @koppor !!! i saw you are going to open a deffect, plase feel free to consider me in resolving, i will appreciate it

koppor · 2025-07-21T16:30:47Z

@SalvadorRomo Thank you! Just grab the issue if you feel comfortable working with. I currently don't have the capacity to do a deep management...

SalvadorRomo and others added 11 commits July 7, 2025 20:35

first changes

dcc6076

partial change

1a76c57

add fields to GUI

aaef2ce

finish change

150bc2c

fix citation count identifier

fe6b48d

adding tests

23fbd53

Merge branch 'JabRef:main' into fix-for-issue-13477

b37475d

add more testing

f4fa327

merge files

1193823

remove unwanted logic

44de54c

add entry to change log

05aa416

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/fieldeditors/identifier/CitationCountEditorViewModel.java Outdated Show resolved Hide resolved

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/fieldeditors/identifier/CitationCountEditorViewModel.java Outdated Show resolved Hide resolved

SalvadorRomo changed the title ~~Fix for issue 13477~~ PR to add a new field for citation count Jul 12, 2025

SalvadorRomo added 9 commits July 12, 2025 12:31

resolve comments

15baed1

resolve comments

19923b8

resolve conflicts

db2ffd2

enhance citation count change log

cd836e7

enhance citation count change log

a90024c

change assertion style

9c3facb

resolve conflicts

84af44f

resolve conflicts

1d265d3

resolve conflicts

8bfc988

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/logic/importer/fetcher/citation/CitationFetcher.java Show resolved Hide resolved

trag-bot bot reviewed Jul 12, 2025

View reviewed changes

jablib/src/main/java/org/jabref/model/entry/field/FieldFactory.java Show resolved Hide resolved

koppor requested changes Jul 12, 2025

View reviewed changes

SalvadorRomo added 3 commits July 12, 2025 17:37

resolve test errors

83709c9

resolve conflicts

4333732

fix branch

18f9de0

trag-bot bot reviewed Jul 13, 2025

View reviewed changes

jabgui/src/main/java/org/jabref/gui/fieldeditors/CitationCountEditor.java Outdated Show resolved Hide resolved

koppor requested changes Jul 16, 2025

View reviewed changes

Salvador Romo and others added 2 commits July 17, 2025 09:13

fix comments

0630f86

Merge branch 'JabRef:main' into fix-for-issue-13477

f8a9733

trag-bot bot reviewed Jul 17, 2025

View reviewed changes

fix tests

5bd1d5a

SalvadorRomo requested a review from koppor July 18, 2025 13:12

SalvadorRomo and others added 5 commits July 19, 2025 06:10

Merge branch 'main' into fix-for-issue-13477

83d3ada

Merge branch 'main' into fix-for-issue-13477

7eb7102

Merge branch 'main' into fix-for-issue-13477

a1eae94

Fix space in fieldname

2ce9536

Use "error" from server for notification of error

deee352

koppor previously approved these changes Jul 21, 2025

View reviewed changes

koppor enabled auto-merge July 21, 2025 09:11

Fix requires for xmlunit

d2d060a

koppor dismissed their stale review via d2d060a July 21, 2025 10:29

koppor previously approved these changes Jul 21, 2025

View reviewed changes

koppor added 2 commits July 21, 2025 13:45

Ensure that streams are closed during test

4734273

Fix test file

51184fa

koppor dismissed their stale review via 51184fa July 21, 2025 11:45

koppor previously approved these changes Jul 21, 2025

View reviewed changes

Fix OpenRewrite

5933eed

koppor dismissed their stale review via 5933eed July 21, 2025 12:32

koppor approved these changes Jul 21, 2025

View reviewed changes

koppor added this pull request to the merge queue Jul 21, 2025

Merged via the queue into JabRef:main with commit d6858cb Jul 21, 2025
44 checks passed

github-actions bot mentioned this pull request Jul 21, 2025

Add citation count field (including semantic scholar fetcher) #13477

Closed

Uh oh!

Add a new field for citation count #13531

Add a new field for citation count #13531

Uh oh!

Conversation

SalvadorRomo commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Mandatory checks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

koppor Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

koppor Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot commented Jul 21, 2025

Uh oh!

Uh oh!

SalvadorRomo commented Jul 21, 2025

Uh oh!

koppor commented Jul 21, 2025

Uh oh!

Uh oh!

SalvadorRomo commented Jul 12, 2025 •

edited

Loading